Reference value endpoints

These endpoints report the values the other campaign endpoints accept and return: the status and failure strings, the time zones a campaign can be scheduled in, and the version of the service itself. Read them from the API rather than hard-coding them, so your client stays current as the set grows.

Get campaign and target status values

This endpoint returns every value a campaign status, a target status and a failure reason can take. These are the strings you filter on with campaignStatus, status and lastFailureReason. See List campaigns and List targets.

Endpoint

GET /api/v1/campaignDialer/values

Request

GET /api/v1/campaignDialer/values HTTP/1.1
Host: livehub.audiocodes.io
Authorization: Bearer {token}

Response

200 OK — the three sets of values.

{
  "campaignStatus": [
    "Not-started",
    "In-progress",
    "Locked",
    "Completed"
  ],
  "targetStatus": [
    "Not initiated",
    "Ongoing",
    "Waiting for reschedule due to retry",
    "Waiting for reschedule due to system failure",
    "Waiting for reschedule due to system CAC",
    "Waiting for reschedule due to bot",
    "Dialer Success",
    "Dialer Failure",
    "Bot Success",
    "Bot Failure"
  ],
  "failureReason": [
    "N/A",
    "Target no answer",
    "Target busy",
    "Target Fax or Answering machine",
    "Target declined",
    "Call failure due to system CAC",
    "Unexpected error",
    "Applicative Bot Failure",
    "Bot rescheduled"
  ]
}

For what a campaign status means, see Campaign statuses.

Get the supported time zones

This endpoint returns the time zones a campaign's schedulerSettings.timeZone can be set to, each with its UTC offset. The list is long; two entries are shown here.

Endpoint

GET /api/v1/campaignDialer/timezone

Request

GET /api/v1/campaignDialer/timezone HTTP/1.1
Host: livehub.audiocodes.io
Authorization: Bearer {token}

Response

200 OK — the time zones.

[
  {
    "timezone": "Pacific/Midway",
    "offset": "-11:00"
  },
  {
    "timezone": "Pacific/Niue",
    "offset": "-11:00"
  }
]

Get the current version

This endpoint returns the version of the campaign service. The version is useful when you report a problem, and it tells you which behavior to expect from an account.

Endpoint

GET /api/v1/campaignDialer/version

Request

GET /api/v1/campaignDialer/version HTTP/1.1
Host: livehub.audiocodes.io
Authorization: Bearer {token}

Response

200 OK — the version.

{
  "managerVersion": "1.0.85-1-g09610e0"
}